GetBinaryValue(DicomElement,Byte[],Int32,Int32) Method

Visual Basic
C#
WinRT C#
Objective-C
Java
WinRT JavaScript
C++

public bool GetBinaryValue( 
   DicomElement element,
   byte[] value,
   int offset,
   int length
)

'Declaration
 
Public Overloads Function GetBinaryValue( _
   ByVal element As DicomElement, _
   ByVal value() As Byte, _
   ByVal offset As Integer, _
   ByVal length As Integer _
) As Boolean

'Usage
 
Dim instance As DicomDataSet
Dim element As DicomElement
Dim value() As Byte
Dim offset As Integer
Dim length As Integer
Dim value As Boolean
 
value = instance.GetBinaryValue(element, value, offset, length)

public bool GetBinaryValue( 
   DicomElement element,
   byte[] value,
   int offset,
   int length
)

ObjectiveC Syntax

 function Leadtools.Dicom.DicomDataSet.GetBinaryValue(DicomElement,Byte[],Int32,Int32)( 
   element ,
   value ,
   offset ,
   length 
)

public:
bool GetBinaryValue( 
   DicomElement^ element,
   array<byte>^ value,
   int offset,
   int length
)

Parameters

element: An item in the Data Set.
value: Buffer that will be updated with the binary value associated with the specified item in the Data Set. You are responsible for allocating the memory for this buffer.
offset: Offset from the beginning of the buffer, at which writing will start.
length: Number of bytes, from the binary value, to write to the buffer.

Return Value

true if the method was able to update the buffer with the binary value; otherwise, false.

Note: You must allocate the memory for value.

If the length specified by the DicomElement.Length property is greater than length, then the binary value copied to the buffer will be truncated to the smaller length. If the the length specified by DicomElement.Length is less than length, then the entire binary value of element will be copied to the buffer.

This method can be called for every Value Representation, and it will return the exact value in the Value Field (unconverted).

For an example, refer to SetIntValue(DicomElement,IntPtr,Int32).

Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

Reference